使用springmvc写controller时，会使用到许多参数绑定的注解，在此记录下常使用到的注解及使用方法、使用情形。
分类
controller的method参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类（主要讲解常用类型）：
- 处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable;
- 处理request header部分的注解： @RequestHeader, @CookieValue;
- 处理request body部分的注解：@RequestParam, @RequestBody;
- 处理attribute类型是注解： @SessionAttributes, @ModelAttribute;
@PathVariable
@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {
@RequestMapping("/pets/{petId}")
public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
// implementation omitted
}
}
上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable(“name”)指定uri template中的名称。
@RequestHeader、@CookieValue
@RequestHeader
@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。
示例代码：
//这是一个Request 的header部分：
Host： localhost:8080
Accept： text/html,application/xhtml+xml,application/ xml;q=0.9
Accept-Language： fr,en-gb;q=0.7,en;q=0.3
Accept-Encoding： gzip,deflate
Accept-Charset： ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive： 300
@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive) {
//...
}
上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。
@CookieValue
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值：
JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
参数绑定的代码：
@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie) {
//...
}
即把JSESSIONID的值绑定到参数cookie上。
@RequestParam, @RequestBody
@RequestParam
- 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String–> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；
- 用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；
- 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定，默认的value是和传入的值相同，required默认值为true；
示例代码：
@Controller
@RequestMapping("/pets")
@SessionAttributes("pet")
public class EditPetForm {
// ...
@RequestMapping(method = RequestMethod.GET)
public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
Pet pet = this.clinic.loadPet(petId);
model.addAttribute("pet", pet);
return "petForm";
}
// ...
@SessionAttributes, @ModelAttribute
@SessionAttributes
该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。
该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；
示例代码：
@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("pet")
public class EditPetForm {
// ...
}
@ModelAttribute
该注解有两个用法，一个是用于方法上，一个是用于参数上；
用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：
- @SessionAttributes 启用的attribute 对象上；
- @ModelAttribute 用于方法上时指定的model对象；
- 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。
用到方法上@ModelAttribute的示例代码：
// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")
@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；
用在参数上的@ModelAttribute示例代码：
@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {
//...
}
首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。
##疑难点##
- 在不给定注解的情况下，参数是怎样绑定的？
若要绑定的对象时简单类型： 调用@RequestParam来处理的。
若要绑定的对象时复杂类型： 调用@ModelAttribute来处理的。
这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；
@RequestMapping ({"/", "/home"})
public String showHomePage(String key, User user){
logger.debug("key="+key);
return "home";
}
第一个参数，默认调用@RequestParam来处理。
第二个参数，默认调用@ModelAttribute来处理。